org.eclipse.vtp.framework.spi
Interface IExecution

All Known Implementing Classes:

Execution

public interface IExecution

A collection of steps in a process.

Author:

Lonnie Pryor

Method Summary

void	dispose() Disposes this execution.
java.lang.String	getExecutionID() Returns the ID of this execution sequence.
ISession	getSession() Returns the session that created this execution.
boolean	hasNextStep() Returns true if there are more steps to perform in the process.
boolean	isNextStepBlocking() Returns true if there is at least one step to perform and the next step may block across executions.
java.lang.Object[]	lookupAllServices(java.lang.String identifier) Returns an array containing all the services registered under the specified identifier.
java.lang.Object	lookupService(java.lang.String identifier) Looks up the service selected for the specified identifier or null if no such service exists.
ICommand	nextStep() Returns the next step in the process.

Method Detail

getExecutionID

java.lang.String getExecutionID()

Returns the ID of this execution sequence.

Returns:

The ID of this execution sequence.

lookupService

java.lang.Object lookupService(java.lang.String identifier)
                               throws java.lang.NullPointerException

Looks up the service selected for the specified identifier or null if no such service exists.

Parameters:

identifier - The identifier of the service to look up.

Returns:

The service selected for the specified identifier or null if no such service exists.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

lookupAllServices

java.lang.Object[] lookupAllServices(java.lang.String identifier)
                                     throws java.lang.NullPointerException

Returns an array containing all the services registered under the specified identifier.

Parameters:

identifier - The identifier of the services to look up.

Returns:

An array containing all the services registered under the specified identifier.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

hasNextStep

boolean hasNextStep()

Returns true if there are more steps to perform in the process.

Returns:

True if there are more steps to perform in the process.

isNextStepBlocking

boolean isNextStepBlocking()

Returns true if there is at least one step to perform and the next step may block across executions.

Returns:

True if there is at least one step to perform and the next step may block across executions

nextStep

ICommand nextStep()
                  throws java.lang.IllegalStateException

Returns the next step in the process.

Returns:

The next step in the process.

Throws:

java.lang.IllegalStateException - If there are no more steps in this process.

getSession

ISession getSession()

Returns the session that created this execution.

Returns:

The session that created this execution.

dispose

void dispose()

Disposes this execution.